Avançar o status de um recurso (apenas sandbox)
Simula, no sandbox, um acontecimento que em produção vem de fora — por exemplo, o banco confirmar um pagamento.
O status de um recurso não pode ser alterado diretamente: ele resulta do histórico de eventos. Esta operação registra um novo evento nesse histórico, e o status passa a refletir o resultado.
Pagamento (resourceId de um pagamento):
event | Efeito | status do Payment | status do meio de pagamento |
|---|---|---|---|
settle | débito liquidado | settled | settled |
fail | recusa do meio de pagamento | failed | failed |
return | falha antes de completar | failed | returned |
require_approval | exige aprovação | pending_approval | dispatched |
approve | aprovação concedida | approved | dispatched |
revert | devolução após liquidar | failed | reverted |
Lote (resourceId de um lote): process, require_approval e expire.
Regras
settled,failedecanceledencerram o ciclo do pagamento: um novo evento retorna409. A única exceção érevert.revertexige que o pagamento tenha liquidado antes; caso contrário retorna409.- Um lote já disparado ou concluído não aceita novos eventos e retorna
409. - Cada evento aplicado também é enviado aos seus webhooks, como
payment.settled.
Request Specifications
Request
Responses
- 200
- 404
- 409
- 422
Evento aplicado; o recurso já reflete o novo status.
Recurso não encontrado
409 — o pedido é válido, mas o estado atual do recurso não permite a operação. Exemplos: cancelar um pagamento já liquidado, abandonar um lote em processamento, parar uma recorrência encerrada. Difere do 422 (a combinação de campos enviada é inválida) e do 409 de pré-condição de meio de pagamento.
Combinação de campos inválida. invalidParams indica o que corrigir.